Skip to content

docs: add CONTRIBUTING.md with setup, code style, and PR guidelines#409

Open
nankingjing wants to merge 1 commit into
zai-org:mainfrom
nankingjing:contrib/add-contributing-and-tests
Open

docs: add CONTRIBUTING.md with setup, code style, and PR guidelines#409
nankingjing wants to merge 1 commit into
zai-org:mainfrom
nankingjing:contrib/add-contributing-and-tests

Conversation

@nankingjing

Copy link
Copy Markdown

Summary

This PR adds a CONTRIBUTING.md file to the repository. The repository currently has no contribution guide (contributing: null in the community profile).

What is included

  • Development setup instructions (Python 3.10+, pip install)
  • Code style guidelines (pre-commit hooks: ruff, ruff-format, typos, pymarkdown)
  • Test running instructions
  • Pull request process with format conventions
  • Types of contributions (bug fixes, features, docs, tests)
  • Guide for adding new apps and action types
  • License information

Why this matters

A CONTRIBUTING.md file is the first thing new contributors look for. Having clear guidelines lowers the barrier for community contributions and ensures consistent code quality.

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

1 participant